Get Content Item's Roles

{ getItemRolesID }

Returns a list of the content item's related security roles.

Method

/API3/content/getItemRolesID

  • API Section: /API3/content
  • API Version: 3.0
  • From Release: 2023.10
  • Can be used by all user types
  • REST API and Client SDK libraries. REST APIs via POST actions only.
  • Input Parameters

    Name

    contentItemId

    Type

    string

    Description

    The system content item ID

    Output Response

    Successful Result Code

    200

    Response List Type

    Description of Response Type

    A generic object used to contain ID of item.. Note that the response is returned as a list of items of this object type.

    Code Snippets

    JavaScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
    -H "paToken: [[apiKey]]" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     "http://Your.Server.URL/API3/content/getItemRolesID" \
     -d ''
    
    import com.pyramidanalytics.*;
    import com.pyramidanalytics.auth.*;
    import com.pyramidanalytics.model.*;
    import com.pyramidanalytics.api.ContentServiceApi;
    
    import java.util.*;
    
    public class ContentServiceApiExample {
        public static void main(String[] args) {
            ApiClient defaultClient = Configuration.getDefaultApiClient();
            defaultClient.setBasePath("http://Your.Server.URL/");
            
            // Configure API key authorization: paToken
            ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
            paToken.setApiKey("YOUR API KEY");
            // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
            //paToken.setApiKeyPrefix("Token");
    
            // Create an instance of the API class
            ContentServiceApi apiInstance = new ContentServiceApi();
            // Initialize the contentItemId parameter object for the call
            String contentItemId = contentItemId_example; // String | 
    
            try {
                // "array[ItemId]" is only psaudo-code to symbolize list of type and not the actual usage 
                array[ItemId] result = apiInstance.getItemRolesID(contentItemId);
                System.out.println(result);
            } catch (ApiException e) {
                System.err.println("Exception when calling ContentServiceApi#getItemRolesID");
                e.printStackTrace();
            }
        }
    }
    
    const PyramidAnalyticsWebApi = require('pyramid_analytics_web_api');
    const defaultClient = PyramidAnalyticsWebApi.ApiClient.instance;
    
    // Configure API key authorization: paToken
    const paToken = defaultClient.authentications['paToken'];
    paToken.apiKey = "YOUR API KEY";
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //paToken.apiKeyPrefix['paToken'] = "Token";
    
    // Create an instance of the API class
    const api = new PyramidAnalyticsWebApi.ContentServiceApi("http://Your.Server.URL")
    const contentItemId = contentItemId_example; // {String} 
    
    const callback = function(error, data, response) {
      if (error) {
        console.error(error);
      } else {
        console.log('API called successfully. Returned data: ' + data);
      }
    };
    api.getItemRolesID(contentItemId, callback);
    
    using System;
    using System.Diagnostics;
    using PyramidAnalytics.Sdk.Api;
    using PyramidAnalytics.Sdk.Client;
    using PyramidAnalytics.Sdk.Model;
    
    public class getItemRolesIDExample
    {
        public static void Main()
        {
            Configuration conf = new Configuration();
            conf.BasePath = "http://Your.Server.URL/";
            
            // Configure API key authorization: paToken
            conf.ApiKey.Add("paToken", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // conf.ApiKeyPrefix.Add("paToken", "Bearer");
    
            GlobalConfiguration.Instance = conf;
            
            // Create an instance of the API class
            var apiInstance = new ContentServiceApi();
            // Initialize the contentItemId parameter object for the call
            var contentItemId = contentItemId_example;  // String | 
    
            try {
                // Returns a list of the content item's related security roles.
                // "array[ItemId]" is only psaudo-code to symbolize array of type and not the actual usage 
                array[ItemId] result = apiInstance.getItemRolesID(contentItemId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentServiceApi.getItemRolesID: " + e.Message );
            }
        }
    }
    
    
    import com.pyramidanalytics
    from com.pyramidanalytics import ApiException
    from pprint import pprint
    
    
    # Configure API key authorization: paToken
    api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_config.api_key_prefix['paToken'] = 'Bearer'
    
    with com.pyramidanalytics.ApiClient(api_config) as api_client:
        # Create an instance of the API class
        api_instance = com.pyramidanalytics.ContentServiceApi(api_client)
        # Initialize the contentItemId parameter object for the call
        contentItemId = contentItemId_example # String | 
    
        try:
            # Returns a list of the content item's related security roles.
            api_response = api_instance.get_item_roles_id(contentItemId)
            pprint(api_response)
        except ApiException as e:
            print("Exception when calling ContentServiceApi->getItemRolesID: %s\n" % e)
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
    
    // Configure API key authorization: paToken
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
    // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    // OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
    
    // Create an instance of the API class
    $api_instance = new OpenAPITools\Client\Api\ContentServiceApi();
    $contentItemId = contentItemId_example; // String | 
    
    try {
        $result = $api_instance->getItemRolesID($contentItemId);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling ContentServiceApi->getItemRolesID: ', $e->getMessage(), PHP_EOL;
    }
    ?>

    Note: Use the 'Authentication' API methods to generate an access 'key' or 'token'.